/*!
    \file    gd32f10x_eval.h
    \brief   definitions for GD32F10x_EVAL's leds, keys and COM ports hardware resources

    \version 2014-12-26, V1.0.0, firmware for GD32F10x
    \version 2017-06-20, V2.0.0, firmware for GD32F10x
    \version 2018-07-31, V2.1.0, firmware for GD32F10x
    \version 2020-09-30, V2.2.0, firmware for GD32F10x
*/

/*
    Copyright (c) 2020, GigaDevice Semiconductor Inc.

    Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice, this 
       list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright notice, 
       this list of conditions and the following disclaimer in the documentation 
       and/or other materials provided with the distribution.
    3. Neither the name of the copyright holder nor the names of its contributors 
       may be used to endorse or promote products derived from this software without 
       specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.
*/

#ifndef GD32F10X_EVAL_H
#define GD32F10X_EVAL_H

#ifdef cplusplus
 extern "C" {
#endif

#include "gd32f10x.h"
     
/* exported types */
typedef enum 
{
    SYSLED = 0,
    RC = 1,
    DRONE = 2,
    CHARGE = 3,
    MQTT = 4
} led_typedef_enum;

typedef enum 
{
    KEY_WAKEUP = 0,
    KEY_RC = 1,
    KEY_DRONE   = 2
} key_typedef_enum;

typedef enum 
{
    KEY_MODE_GPIO = 0,
    KEY_MODE_EXTI = 1
} keymode_typedef_enum;

/* eval board low layer led */
#define LEDn                             5U

#define SYSLED_PIN                         GPIO_PIN_9
#define SYSLED_GPIO_PORT                   GPIOB
#define SYSLED_GPIO_CLK                    RCU_GPIOB
  
#define RC_PIN                           GPIO_PIN_6
#define RC_GPIO_PORT                     GPIOB
#define RC_GPIO_CLK                      RCU_GPIOB
  
#define DRONE_PIN                         GPIO_PIN_5
#define DRONE_GPIO_PORT                   GPIOB
#define DRONE_GPIO_CLK                    RCU_GPIOB
  
#define CHARGE_PIN                        GPIO_PIN_7
#define CHARGE_GPIO_PORT                  GPIOB
#define CHARGE_GPIO_CLK                   RCU_GPIOB

#define MQTT_PIN                          GPIO_PIN_6
#define MQTT_GPIO_PORT                    GPIOA
#define MQTT_GPIO_CLK                     RCU_GPIOA

#define COMn                             2U

#define EVAL_COM0                        USART0
#define EVAL_COM0_CLK                    RCU_USART0
#define EVAL_COM0_TX_PIN                 GPIO_PIN_9
#define EVAL_COM0_RX_PIN                 GPIO_PIN_10
#define EVAL_COM0_GPIO_PORT              GPIOA
#define EVAL_COM0_GPIO_CLK               RCU_GPIOA

#define EVAL_COM1                        USART1
#define EVAL_COM1_CLK                    RCU_USART1
#define EVAL_COM1_TX_PIN                 GPIO_PIN_2
#define EVAL_COM1_RX_PIN                 GPIO_PIN_3
#define EVAL_COM1_GPIO_PORT              GPIOA
#define EVAL_COM1_GPIO_CLK               RCU_GPIOA

#define KEYn                             3U

/* wakeup push-button */
#define WAKEUP_KEY_PIN                   GPIO_PIN_0
#define WAKEUP_KEY_GPIO_PORT             GPIOA
#define WAKEUP_KEY_GPIO_CLK              RCU_GPIOA
#define WAKEUP_KEY_EXTI_LINE             EXTI_0
#define WAKEUP_KEY_EXTI_PORT_SOURCE      GPIO_PORT_SOURCE_GPIOA
#define WAKEUP_KEY_EXTI_PIN_SOURCE       GPIO_PIN_SOURCE_0
#define WAKEUP_KEY_EXTI_IRQn             EXTI0_IRQn  

/* tamper push-button */
#define RC_KEY_PIN                   GPIO_PIN_15
#define RC_KEY_GPIO_PORT             GPIOB
#define RC_KEY_GPIO_CLK              RCU_GPIOB
#define RC_KEY_EXTI_LINE             EXTI_15
#define RC_KEY_EXTI_PORT_SOURCE      GPIO_PORT_SOURCE_GPIOB
#define RC_KEY_EXTI_PIN_SOURCE       GPIO_PIN_SOURCE_15
#define RC_KEY_EXTI_IRQn             EXTI10_15_IRQn

/* user push-button */
#define DRONE_KEY_PIN                     GPIO_PIN_14
#define DRONE_KEY_GPIO_PORT               GPIOB
#define DRONE_KEY_GPIO_CLK                RCU_GPIOB
#define DRONE_KEY_EXTI_LINE               EXTI_14
#define DRONE_KEY_EXTI_PORT_SOURCE        GPIO_PORT_SOURCE_GPIOB
#define DRONE_KEY_EXTI_PIN_SOURCE         GPIO_PIN_SOURCE_14
#define DRONE_KEY_EXTI_IRQn               EXTI10_15_IRQn

/* function declarations */
/* configure led GPIO */
void gd_eval_led_init(led_typedef_enum lednum);
/* turn on selected led */
void gd_eval_led_on(led_typedef_enum lednum);
/* turn off selected led */
void gd_eval_led_off(led_typedef_enum lednum);
/* toggle the selected led */
void gd_eval_led_toggle(led_typedef_enum lednum);
/* configure key */
void gd_eval_key_init(key_typedef_enum key_num, keymode_typedef_enum key_mode);
/* return the selected key state */
uint8_t gd_eval_key_state_get(key_typedef_enum key);
/* configure COM port */
void gd_eval_com_init(uint32_t com, uint32_t baud);

#ifdef cplusplus
}
#endif

#endif /* GD32F10X_EVAL_H */
